home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / EDUCATE / PEDRAW13.ARJ / PEDRAW.DOC < prev    next >
Text File  |  1991-06-28  |  45KB  |  1,055 lines
  1.  
  2.  
  3.  
  4.  
  5.                             PEDRAW.DOC v1.2                             
  6.  
  7.         PEDRAW is a program which draws out family trees in either text
  8.         or graphics mode. It is designed to be used to help with
  9.         genetics research, especially linkage analysis using the LINKAGE
  10.         and LINKSYS packages.
  11.  
  12.  
  13.         * OVERVIEW
  14.  
  15.         Data about the structure of the pedigree and about the
  16.         individuals within it is read in from a data file which can have
  17.         one of a variety of formats. One individual is selected and his
  18.         relatives are displayed either diagramatically using shaded
  19.         symbols or else as paragraphs of text linked by the IBM box
  20.         character set. The pedigree is saved to disk in either Microsoft
  21.         Paint Format or as a text file.
  22.  
  23.  
  24.         * SPECIFICATIONS
  25.  
  26.         Needs a PC, DOS 2.0 or higher, 350K of RAM, any graphics monitor
  27.         type. To do graphics pedigrees of a reasonable size you'll need
  28.         a hard disk with some free space on it. To print out graphics
  29.         you need an Epson or IBM compatible dot matrix printer, or a
  30.         PostScript or HP-compatible laser printer, or you need Microsoft
  31.         Windows or some other program that can read Microsoft Paint
  32.         (MSP) files so you can use its printer drivers. The number of
  33.         individuals displayed is limited by the amount of available
  34.         memory. Multiple marriages and in-breeding can be accommodated
  35.         to a reasonable extent, though may require some trial and error
  36.         to produce the best result.
  37.  
  38.  
  39.         * PROGRAM MENU FUNCTIONS
  40.  
  41.         Options are selected using the Up and Down arrow keys, followed
  42.         by Enter (CR). Jump straight to an option by pressing the key
  43.         corresponding to the first letter of the option's name. The Esc
  44.         key generally quits a menu to the one at a higher level.
  45.  
  46.         * Load pedigree file
  47.  
  48.         Loads a file in from disk. File must be of acceptable format
  49.         (see section on "Data files"). If the file has extension .DAT,
  50.         .SDF, .PED or .PPD then the appropriate format is assumed,
  51.         otherwise the user must specify the format.
  52.  
  53.         * Edit a file
  54.  
  55.         A simple text editor is supplied enabling the user to read or
  56.         edit a file on disk or create a new file. The F1 provides help
  57.         listing the functions available and the Esc key quits the editor
  58.         so that the file can be saved to disk. This editor can be used
  59.         to edit data files if desired.
  60.  
  61.  
  62.                                    1                                    
  63.  
  64.  
  65.  
  66.  
  67.                             PEDRAW.DOC v1.2                             
  68.  
  69.         * Save pedigree file
  70.  
  71.         The pedigree data in memory is saved to disk. You are advised to
  72.         give the file the extension .DAT so that it will be correctly
  73.         recognised when it is subsequently loaded by PEDRAW.
  74.  
  75.         * Adjust pedigree
  76.  
  77.         Use this option to alter current pedigree data or create new
  78.         data (by adding members). Every individual must have a unique
  79.         ID, and the structure of the pedigree is determined by
  80.         specifying the ID's of parents where relevant. Only the last
  81.         three digits of the ID will be displayed in the pedigree
  82.         diagram, and the rest of the ID may refer e.g. to family number.
  83.         The shading is determined by the diagnosis code: 1 for filled
  84.         in, 2 for half-filled and other numbers up to 9 for patterned
  85.         shading. If 100 is added to this code the individual is marked
  86.         as dead. When adding or editing a member, press F10 when the
  87.         information is complete, or Esc to cancel the operation.
  88.         Promoting and demoting members moves them to the start or end of
  89.         the list of pedigree members, controlling the way the pedigree
  90.         will be displayed (for further information see the section
  91.         explaining the algorithm used).
  92.  
  93.         * Configure settings
  94.  
  95.         This option is used to adjust the way the pedigree is drawn. The
  96.         current configuration can be saved to disk, or a previously
  97.         saved configuration can be loaded. If a configuration is saved
  98.         to the file PEDRAW.CFG in the current working directory, then
  99.         that configuration will be automatically loaded the next time
  100.         PEDRAW is run from that directory.
  101.  
  102.         When the option to change the configuration is selected, any of
  103.         the command line flags can be entered if desired (see section on
  104.         "Flags"), but unless the program is being run in batch mode it
  105.         is best just to press Enter to edit the options individually.
  106.  
  107.         If "Graphic display" is set to N a text file will be created
  108.         with extension .TRE. The default is instead to produce a
  109.         graphical display of the pedigree structure.
  110.  
  111.         If "Conceal sex" is set to Y then all individuals will be
  112.         displayed as diamonds. This is to improve confidentiality when
  113.         pedigrees are published.
  114.  
  115.         If "Conceal diagnosis" is set to Y then no individuals will be
  116.         shaded. This is to maintain blindness among other members of the
  117.         research team, e.g. laboratory workers assigning genotype.
  118.  
  119.         If "Codes for Epson printer" is set to Y then at the start of a
  120.         text file (TRE file) the codes to make an Epson printer output
  121.         the IBM box character set correctly are added (otherwise you
  122.         would get italics, etc.). This has no effect on ordinary
  123.  
  124.                                    2                                    
  125.  
  126.  
  127.  
  128.  
  129.                             PEDRAW.DOC v1.2                             
  130.  
  131.         graphics (MSP) files.
  132.  
  133.         If "File name for saved diagram" is left blank then a default
  134.         filename will be used, consisting of the ID of the individual of
  135.         used as the pedigree ancestor with the extension .MSP for
  136.         graphics files or .TRE for text files. So the pedigree diagram
  137.         produced by selecting individual 12099 as the ancestor would be
  138.         saved to file 12099.MSP. If the filename is set to 0 then the
  139.         diagram will not be saved to disk, only displayed on screen.
  140.         Otherwise any filename can be specified and the diagram will be
  141.         saved with that name.
  142.  
  143.         The "Title" can be set to say anything. It will be printed out
  144.         under the pedigree diagram.
  145.  
  146.         The "Numbers of lines to show" refers to which lines are to be
  147.         displayed. The default is the first 5. Line 1 is the ID line,
  148.         and then lines 2 to 11 are the optional text lines. The line
  149.         numbers are entered separated by commas. To display the ID, if
  150.         the ID contains a hyphen it is assumed that the LINKSYS format
  151.         is used so that members have ID's such as 1-2, 2-3, etc.
  152.         Therefore the first digit before the hyphen and all subsequent
  153.         characters are displayed. If there is no hyphen in the ID code,
  154.         it is assumed that the last 3 digits of the ID refer to the code
  155.         of an individual within a family, and that the earlier
  156.         characters may refer to the family code. Accordingly only the
  157.         last 3 digits are displayed (and leading zeroes are removed).
  158.         With the text lines, the number of characters displayed depends
  159.         on the width of the symbols and of the gap between symbols.
  160.  
  161.         The symbol and gap height and width in pixels can be set. The
  162.         minimum values for these are 4 and the maximum depends on the
  163.         screen type. The sum of the symbol width and gap width must be a
  164.         multiple of eight. The extra line height refers to the vertical
  165.         space taken up by extra lines which are created either  when
  166.         multiple marriages occur or when a line is drawn through the
  167.         pedigree when an intermarriage has occurred. The tip is that if
  168.         you want to leave room for more characters of text lines to be
  169.         displayed, the best thing to do is to increase the width of the
  170.         gap between symbols but leave other dimensions unchanged.
  171.  
  172.         It is possible to limit the number of generations to be printed,
  173.         perhaps if you have trouble fitting them on paper.
  174.  
  175.         The "Show all members" option is quite important. If it is set
  176.         to N (the default) then when a pedigree is drawn and an ancestor
  177.         is selected, only his descendants and their spouses (and their
  178.         spouses' descendants and their spouses' spouses) are displayed.
  179.         If the "Show all members" option is set to Y then the program
  180.         looks for the oldest ancestor of each person marrying in to the
  181.         pedigree and shows all their descendants as well. In addition
  182.         the original ancestor used is not the person selected by the
  183.         user but that person's oldest ancestor, so this option can be
  184.         useful if you have forgotten the pedigree structure and want to
  185.  
  186.                                    3                                    
  187.  
  188.  
  189.  
  190.  
  191.                             PEDRAW.DOC v1.2                             
  192.  
  193.         have the ancestor selected automatically. See the section
  194.         explaining the algorithm used for fuller details of how the
  195.         program behaves.
  196.  
  197.         The maximum number of rows (generations) and columns in the
  198.         pedigree diagram can be altered from the default values, though
  199.         the numbers that can in practice be used are limited by the
  200.         available memory.
  201.  
  202.         * Display pedigree
  203.  
  204.         Once the pedigree structure has been set up this option enables
  205.         you to display it on screen and save the diagram to disk. Just
  206.         select the individual whose descendants are to be drawn.
  207.  
  208.         * Make key
  209.  
  210.         Produce a simple key for the pedigree diagram indicating the
  211.         scheme used for shading symbols. The file giving this
  212.         information must already exist on disk (it can be created with
  213.         the "Edit a file option"). The format of the file is that there
  214.         is one optional title line for the key, followed by up to ten
  215.         lines each beginning with a number followed by an explanation of
  216.         the diagnosis this represents, e.g.:
  217.  
  218.         Key for manic depressive pedigree
  219.         1 Bipolar disorder
  220.         2 Unipolar depression
  221.         0 Unaffected
  222.         100 Deceased
  223.  
  224.         A male symbol shaded appropriately will be drawn followed by the
  225.         text given.
  226.  
  227.         You will also be prompted for the name of the file to save the
  228.         key to, and this should have the extension MSP, e.g. KEY.MSP.
  229.         Alternatively entering 0 for the filename will prevent the key
  230.         being saved to disk.
  231.  
  232.         * Use DOS
  233.  
  234.         Enter any DOS commands, e.g. to copy, rename or delete files, or
  235.         run another program if there is enough memory left.
  236.  
  237.         * Quit program
  238.  
  239.         Quit program. Beware, all unsaved data will be lost!
  240.  
  241.  
  242.         * FLAGS
  243.  
  244.         These can either be entered on the command line, when the
  245.         program is first run, or when the "Configure settings" option is
  246.         chosen, or in batch mode instead of an ID. All flags may be
  247.  
  248.                                    4                                    
  249.  
  250.  
  251.  
  252.  
  253.                             PEDRAW.DOC v1.2                             
  254.  
  255.         upper or lower case. To use flags on the command line enter:
  256.  
  257.         PEDRAW /FLAG1 /FLAG2 etc.
  258.  
  259.         or:
  260.  
  261.         PEDRAW datafile.dat /FLAG1 /FLAG2 etc.
  262.  
  263.         The section on the "Configure settings" option clarifies the
  264.         effects of some of the flags.
  265.  
  266.  
  267.         /P or /P1  - draw Pictures, enter graphics mode.
  268.  
  269.         /P0        - leave graphics mode, display text.
  270.  
  271.         /E or /E1  - send a code to the text file which instructs Epson-
  272.                      compatible printers to print the graphics character
  273.                      set correctly - this is the default.
  274.  
  275.         /E0        - do not insert special characters into text file, to
  276.                      allow output to e.g. IBM compatible printers and
  277.                      some word processors.
  278.  
  279.         /Gx        - print only first x generations, default is 6.
  280.  
  281.         /Lx        - determines whether or not a line from an
  282.                      individual's entry is displayed; the default is to
  283.                      just display the last three digits of an
  284.                      individual's ID number (line 1 displayed) and the
  285.                      first four text lines but up eleven lines can be
  286.                      displayed. To turn, for example, line 6 on enter
  287.                      /L6. To turn a line off again the negative number
  288.                      is used, e.g. /L-2. x = 1 to 11 or -1 to -11.
  289.  
  290.         /Ttitle    - set the title to the words following /T, until the
  291.                      next / is encountered. This will not work for more
  292.                      than one word if the switch is used on the command
  293.                      line.
  294.  
  295.         /Ffile     - sets the filename to save the pedigree diagram to.
  296.                      /F0 means don't save it. /F means use default name.
  297.  
  298.         /A         - attempts to display all relatives; when an ancestor
  299.                      is entered the program seeks to find his oldest
  300.                      ancestor; when all that ancestor's descendants have
  301.                      been displayed the family trees of everybody
  302.                      marrying into the pedigree are then mapped out, and
  303.                      so on.
  304.  
  305.         /B or /B1  - blanks out diagnoses, all symbols are left
  306.                      unshaded.
  307.  
  308.         /B0        - shades symbols according to coding.
  309.  
  310.                                    5                                    
  311.  
  312.  
  313.  
  314.  
  315.                             PEDRAW.DOC v1.2                             
  316.  
  317.  
  318.         /U or /U1  - unsexes individuals so that all symbols are
  319.                      displayed as diamonds regardless of gender.
  320.  
  321.         /U0        - displays males as squares, females as circles.
  322.  
  323.         /M         - use menus, quit batch mode.
  324.  
  325.         /Cx        - set maximum number of columns in the pedigree
  326.                      diagram to x. Default is 200.
  327.  
  328.         /Rx        - set maximum number of rows (generations) in the
  329.                      pedigree diagram to x (though number actually
  330.                      displayed can be limited by /G). Default is 8.
  331.  
  332.         /SWx       - Set symbol width in pixels to x. Default is 24.
  333.  
  334.         /GWx       - Set width of gap between symbols in pixels to x.
  335.                      Note that the width of the symbol plus the width of
  336.                      the gap must sum to a multiple of 8. Default is 16.
  337.  
  338.         /SHx       - Set symbol height in pixels to x. Default is 24.
  339.  
  340.         /GHx       - Set height of gap between symbols in pixels to x.
  341.                      Default is 16.
  342.  
  343.         /Hx        - Set height of extra lines (for second marriages,
  344.                      etc. ) in pixels to x. Default is 12.
  345.  
  346.         * DATA FILES
  347.  
  348.         PEDRAW accepts pedigree data arranged in one of four formats: as
  349.         a PEDRAW data file, as a LINKSYS SDF file, or as a LINKAGE PED
  350.         file either before or after passing through MAKEPED. PEDRAW
  351.         determines the format of the file by its extension. If the
  352.         filename ends .DAT then it is assumed to be in PEDRAW format. If
  353.         it ends .SDF it is assumed to be in LINKSYS SDF format (produced
  354.         by using the "Export" option of LINKSYS). If it has the
  355.         extension .PED it is assumed to be a LINKAGE pedigree data file
  356.         before MAKEPED has been run on it (i.e. without sibling
  357.         pointers), and if it has the extension .PPD then it is assumed
  358.         to be a LINKAGE pedigree file output from MAKEPED. If the data
  359.         file has none of these extensions then the program will ask
  360.         which format the file is in. Note that there is no way to
  361.         override the default interpretation. That is if you have a
  362.         LINKAGE file called PEDATAIN.DAT, PEDRAW will misread the file
  363.         and report an error. The file would have to be renamed e.g. to
  364.         PEDATAIN.PPD before PEDRAW could use it.
  365.  
  366.         * PEDRAW data file format
  367.  
  368.         This is the format in which PEDRAW itself saves files. The file
  369.         should be saved with the extension .DAT. This format will be
  370.         created automatically when pedigree data is saved using the
  371.  
  372.                                    6                                    
  373.  
  374.  
  375.  
  376.  
  377.                             PEDRAW.DOC v1.2                             
  378.  
  379.         "Save pedigree file" option. The file is a plain text file which
  380.         can be created by a word processor or the text editor supplied
  381.         with PEDRAW (selected by the "Edit a file" option), or if
  382.         pedigree information is kept in a database a report can be set
  383.         up to export information in the correct format.
  384.  
  385.         Each individual needs at least 13 lines. The first line contains
  386.         the ID. The second line is the gender (M, F or X) and an
  387.         optional diagnosis code which is a number from 0 to 9 to
  388.         indicate how the symbol will be shaded. If 100 is added to this
  389.         number the individual is marked as dead. The diagnosis code is
  390.         separated from the gender by a comma. The next line optionally
  391.         contains the ID's of the father then mother, separated by a
  392.         comma. The next ten lines can contain any text. The maximum
  393.         length of a an ID or text line is 20 characters. Example:
  394.  
  395.         12032
  396.         F,4
  397.         12048,12060
  398.         Miss Linda Smith
  399.         Schizophrenic
  400.         AB
  401.         pos
  402.         wx
  403.         Rr
  404.              ... four more lines, some can be blank.
  405.  
  406.         Note that there is no obligation to keep separate pedigrees in
  407.         separate files. Information about several pedigrees can be
  408.         stored in the same data file, provided each individual has a
  409.         unique ID.
  410.  
  411.         A diagnosis code of 1 shades solid, 2 is half-filled and the
  412.         other numbers produce different patterns. Males are squares,
  413.         females circles and unknowns (X) diamonds.
  414.  
  415.         * Other data formats
  416.  
  417.         These are only worth using if you are actually using the LINKSYS
  418.         and/or LINKAGE programs, so the format of the files will not be
  419.         described. Files can only be read in from these formats, not
  420.         saved (though the data input can then be saved in PEDRAW
  421.         format).
  422.  
  423.         The SDF format is created from LINKSYS by using the "Export"
  424.         option. If PEDRAW reads such a file in it treats it in the
  425.         following way:
  426.  
  427.         1. A new ID is created by concatenating the individual's family
  428.         name with the LINKSYS ID to create a new unique name (meaning
  429.         that information about several different pedigrees can be
  430.         contained in the one SDF file). So individual 2-5 from pedigree
  431.         F9 becomes F92-5.
  432.  
  433.  
  434.                                    7                                    
  435.  
  436.  
  437.  
  438.  
  439.                             PEDRAW.DOC v1.2                             
  440.  
  441.         2. Each of the (up to) ten phenotype codes is read into the ten
  442.         text lines.
  443.  
  444.         3.In a somewhat feeble attempt to guess diagnosis the program
  445.         assumes that the first phenotype code refers to affection
  446.         status. If it begins with a "2" or contains a "-2" (e.g. if the
  447.         phenotype code is "1-2") then the PEDRAW diagnosis code is set
  448.         to 1 (for solid shading). Otherwise it is set to 0. If this does
  449.         not end up right the diagnosis codes can be adjusted
  450.         subsequently by hand using the "Adjust pedigree" option.
  451.  
  452.         LINKAGE pedigree files can be read in directly (handy for
  453.         checking coding). There must be at least two spaces between
  454.         locus codes, and only single spaces between the symbols within a
  455.         locus code, i.e. PEDRAW expects to find codes such as:
  456.  
  457.         2  1 1 1  0 1 0  1 1
  458.  
  459.         PEDRAW expects to find a file with extension .PED to be in a
  460.         format suitable to be read by MAKEPED, and with .PPD if the file
  461.         has been output by MAKEPED. This clashes with the convention
  462.         suggested in the most recent LINKAGE documentation of having the
  463.         former with an extension .DAT and the latter with an extension
  464.         .PED. The PEDRAW convention is the one used by LINKSYS and files
  465.         may have to be renamed accordingly.
  466.  
  467.         LINKAGE files are treated as follows:
  468.  
  469.         1. A unique ID number is constructed by multiplying the pedigree
  470.         number by 1000 and adding the individual number, so that
  471.         individual 2 from pedigree 3 gets an ID of 3002.
  472.  
  473.         2. Each of the locus codes is read into a text line. Single
  474.         spaces within locus codes are removed, so that 0 1 1 becomes
  475.         011.
  476.  
  477.         3. As for LINKSYS files, PEDRAW attempts to guess the diagnosis
  478.         code by assuming that the first locus code is affection status.
  479.         If the first digit of the first locus code is 2 the diagnosis
  480.         code is set to 1 (for solid shading), otherwise it is set to 0.
  481.  
  482.  
  483.         * USING PEDRAW IN BATCH MODE
  484.  
  485.         Usually PEDRAW is operated interactively from menus. It is also
  486.         possible to run PEDRAW in batch mode so that it takes all its
  487.         entry from standard input, meaning that input can be redirected
  488.         into PEDRAW using DOS commands. The way to start PEDRAW in batch
  489.         mode is to give the name of a data file on the command line
  490.         e.g.:
  491.  
  492.         PEDRAW EXPED.DAT
  493.  
  494.         The data file must exist and must have the extension .DAT or
  495.  
  496.                                    8                                    
  497.  
  498.  
  499.  
  500.  
  501.                             PEDRAW.DOC v1.2                             
  502.  
  503.         .SDF or .PED or .PPD so that PEDRAW knows what format to expect.
  504.         PEDRAW then moves directly to the "Display pedigree" option and
  505.         awaits the input of the ID of an individual whose descendants
  506.         are to be displayed. However in batch mode it is possible
  507.         instead to enter flags at this point. PEDRAW carries on reading
  508.         commands from standard input until either there is an error, or
  509.         until the end of the input file is reached, or until an 'X' is
  510.         input or until the /M flag is selected. If the end of file is
  511.         reached or an 'X' is input the program exits, otherwise it just
  512.         reverts back to ordinary menu-driven operation. To use PEDRAW
  513.         with redirected input one might run it like so:
  514.  
  515.         PEDRAW EXPED.DAT < INPUT.JF
  516.  
  517.         Here INPUT.JF would contain a list of ID's and flags as follows:
  518.  
  519.         12880
  520.         13990
  521.         /l-2 /l-3 /f1out.msp /tRelatives of number 14001 /a
  522.         14001
  523.         x
  524.  
  525.         This would display the descendants of 12880 and 13990, saving
  526.         the diagrams to 12880.MSP and 13990.MSP, then would draw a
  527.         diagram of all the relatives of 14001 and save it in the file
  528.         1OUT.MSP with an appropriate title. The x at the end is not
  529.         strictly necessary but marks the end of file and quits PEDRAW.
  530.  
  531.         Note that in batch mode the normal editing keys do not work
  532.         (cursor keys, control-left-arrow, etc.).
  533.  
  534.  
  535.         * SETTING THE GRAPHICS DISPLAY
  536.  
  537.         If the program won't display graphics and prints the message
  538.         "fg_init() failed" then you will have to set an environment
  539.         variable to the name of your display type. To do this, before
  540.         you run PEDRAW type the following line:
  541.  
  542.         SET FG_DISPLAY=xxxx
  543.  
  544.         except instead of xxxx type one of the following:
  545.  
  546.         HERC
  547.         CGAHIRES
  548.         EGAECD
  549.         VGA11
  550.         VGA12
  551.         EGAMONO
  552.         EGACOLOR
  553.         TOSHIBA
  554.         8514A
  555.  
  556.         Which one you type depends on the kind of display you have which
  557.  
  558.                                    9                                    
  559.  
  560.  
  561.  
  562.  
  563.                             PEDRAW.DOC v1.2                             
  564.  
  565.         you will have to determine from reading your computer manual or
  566.         by asking your supplier. So if you have a Hercules-compatible
  567.         display you would type:
  568.  
  569.         SET FG_DISPLAY=HERC
  570.  
  571.         and if you had a CGA display you would type:
  572.  
  573.         SET FG_DISPLAY=CGAHIRES
  574.  
  575.         and so on. You may want to put this line in your AUTOEXEC.BAT
  576.         file.
  577.  
  578.  
  579.         * PRINTING OUT PEDIGREES
  580.  
  581.         Text pedigrees can be read into a word processor and printed out
  582.         from there, or can be printed directly to an Epson or IBM
  583.         compatible printer with the following command:
  584.  
  585.         COPY filename.tre PRN
  586.  
  587.         Graphics pedigrees can be input into Microsoft Paint, edited if
  588.         necessary, and then output to a printer. New versions of Paint
  589.         no longer work correctly with large diagrams. Other programs
  590.         designed to work with Microsoft Paint files can also be used,
  591.         for example WordPerfect 5 works well (at least for small
  592.         pedigrees) and can be used to incorporate pedigree diagrams into
  593.         text.
  594.  
  595.         To print out pedigrees without using Microsoft Windows the
  596.         program PRMSP.EXE can be used to print MSP files to an Epson or
  597.         IBM compatible dot-matrix printer or a laser printer:
  598.  
  599.         PRMSP filename.msp
  600.  
  601.         The full details of the options available with PRMSP are as
  602.         follows:
  603.  
  604.         Format: PRMSP infile.msp [outfile.prn] [/flag1 /flag2 etc.]
  605.  
  606.         infile.msp - the name of the saved MSP file to be printed out.
  607.  
  608.         outfile.prn - the name of a file to be printed to. This is
  609.         optional and if no name is given then the printer (PRN) will be
  610.         used instead.
  611.  
  612.         /I - this flag means print to an IBM-compatible printer instead
  613.         of an Epson-compatible printer.
  614.  
  615.         /P - this flag means print the pedigree with the paper in
  616.         "portrait" orientation - across the page - instead of the
  617.         default "landscape" orientation - down the page. Note that in
  618.         earlier versions of PRMSP this had the opposite effect because
  619.  
  620.                                    10                                   
  621.  
  622.  
  623.  
  624.  
  625.                             PEDRAW.DOC v1.2                             
  626.  
  627.         it was taken to refer to the orientation of the diagram rather
  628.         than the paper.
  629.  
  630.         /H - high density - will work only with Epson-compatible 24-pin
  631.         printer to give a picture three times smaller than above, or
  632.         twice as small on a Hewlett-Packard compatible laser printer.
  633.  
  634.         /D - draught mode - should be quicker but lower quality for dot
  635.         matrix printers in high density mode or "portrait" orientation.
  636.         On Hewlett-Packard compatible laser printers prints out double
  637.         normal size.
  638.  
  639.         /Snumber - this flag means print "number" spaces before each
  640.         line of the picture - use it to control where the graph appears
  641.         on the page. The default is 6. (Only for dot matrix printers.)
  642.  
  643.         /Lnumber - this flag controls the line spacing on the printer,
  644.         as used by the ESC A command. By default "number" is set to 8,
  645.         but if the lines of your graph come out separated or
  646.         overlapping, then using this flag may help you to adjust the
  647.         line-spacing to produce a better picture. (Only for dot matrix
  648.         printers.)
  649.  
  650.         /Fnumber - this flag lets you determine whether a line feed (new
  651.         line) character is sent to your printer with each carriage
  652.         return character. If number is 0 then no line feed is sent, if
  653.         it is 1 then a line feed is sent. The default is 1. If your
  654.         graph comes out "double-spaced" - with gaps between each line -
  655.         then specifying /F0 may cure the problem. (Only for dot matrix
  656.         printers.)
  657.  
  658.         /FF - send a formfeed (new page) after printing the file. (You
  659.         must use this flag on the last file you print on a PostScript
  660.         printer, but other files can be printed on the same page first.)
  661.  
  662.         /HP - produce output for a Hewlett-Packard compatible laser
  663.         printer.
  664.  
  665.         /PS - produce output for a PostScript printer.
  666.  
  667.         For Hewlett-Packard or PostScript printers only:
  668.  
  669.         /OXnumber - x origin, default 72. Measured in points (1/72")
  670.         approximately from the bottom left corner of an A4 page.
  671.  
  672.         /OYnumber - y origin, default 72 in "portrait" orientation for
  673.         bottom left corner, or 720 in "landscape" orientation for top
  674.         left corner.
  675.  
  676.         For PostScript printers only:
  677.  
  678.         /SXnumber - x scale, default 1.0.
  679.  
  680.         /SYnumber - y scale, default 1.0.
  681.  
  682.                                    11                                   
  683.  
  684.  
  685.  
  686.  
  687.                             PEDRAW.DOC v1.2                             
  688.  
  689.  
  690.         /ROnumber - rotation about origin, default 0.0
  691.  
  692.         Example use of PRMSP:
  693.  
  694.         PRMSP 12990.MSP TEMP.PRN /S12 /I
  695.  
  696.         The file 12990.MSP would be printed out to the file TEMP.PRN, in
  697.         a format suitable for sending to an IBM-compatible printer. Then
  698.         later TEMP.PRN could be printed by entering:
  699.  
  700.         PRINT TEMP.PRN
  701.  
  702.         The advantage of this is that by using the DOS PRINT command
  703.         printing occurs in background - you can get on with other things
  704.         while the graph is being printed.
  705.  
  706.         Note: except in the case of PostScript printers, PRMSP cannot
  707.         work if your computer does not send 8 data bits to the printer.
  708.         This is sometimes altered by the MODE command which is usually
  709.         in the AUTOEXEC.BAT file - see your DOS manual for details - and
  710.         it is especially likely to have been used if your printer is on
  711.         a serial cable rather than the ordinary "Centronics" parallel
  712.         cable. Also make sure that your printer is set to receive 8 bits
  713.         rather than 7 - see your printer manual if you have problems.
  714.  
  715.         Note that to print just one file on a PostScript printer you
  716.         should use the /FF flag to produce a formfeed.
  717.  
  718.  
  719.         * EXPLANATION OF MAPPING ALGORITHM
  720.  
  721.         This is provided so that the optimum order for including people
  722.         in the data file can be decided upon. The aim would be to reduce
  723.         the number of crossings over of lines, and to avoid having to
  724.         repeat individuals in different parts of the diagram.
  725.  
  726.         In general people are added to the pedigree diagram in order
  727.         from top to bottom and from left to right. The algorithm used is
  728.         as follows:
  729.  
  730.         1. An individual whose descendants are to be displayed is
  731.         selected by the user.
  732.  
  733.         2. If the option to extend the pedigree and show all members is
  734.         selected then instead of starting with the individual given the
  735.         program attempts to begin with the oldest ancestor of this
  736.         individual it can find.
  737.  
  738.         3. The following process is repeated (recursively) for each
  739.         individual in turn, beginning with the common ancestor provided.
  740.  
  741.         A. The index individual is marked as "dealt with", and is drawn.
  742.  
  743.  
  744.                                    12                                   
  745.  
  746.  
  747.  
  748.  
  749.                             PEDRAW.DOC v1.2                             
  750.  
  751.         B. The next spouse of the index individual is selected. The next
  752.         spouse is the one who has a child which appears in the data file
  753.         before the children of other spouses, provided that the spouse
  754.         is not marked as "dealt with".
  755.  
  756.         C. Each of the children of the index individual and this spouse
  757.         is in turn selected. If the child has already been drawn then a
  758.         line will be drawn from the current sibship to the place where
  759.         the child appears in the pedigree, unless the child has been
  760.         shown in an earlier generation (when the line would have to go
  761.         "uphill"), in which case the child is drawn again but is marked
  762.         as a repeat ("REP"). If the child is not marked as "dealt with"
  763.         it is set as the new index individual and the process beginning
  764.         in 3A is applied to it (i.e. it's spouses and children will be
  765.         displayed).
  766.  
  767.         D. If the option to extend the pedigree and show all members is
  768.         selected then the oldest ancestor of the spouse is added to a
  769.         "to-be-done-later" list.
  770.  
  771.         E. The spouse is set to be the new index individual and the
  772.         process beginning in 3A is applied to it.
  773.  
  774.         4. If the option to extend the pedigree and show all members is
  775.         selected then for everyone in the "to-be-done-later" list the
  776.         process beginning in 3A is applied.
  777.  
  778.         The above algorithm actually works quite well, even for fairly
  779.         complex pedigrees. However it does fall down if there is a
  780.         complete marriage loop, as when a husband has children by his
  781.         ex-wife's ex-husband's ex-wife. If H1 has children by W1 and W1
  782.         has children by H2 and H2 has children by W2, then if W2 has
  783.         children by H1 the program will not display them (or the
  784.         marriage between H1 and W2) because H1 will already be marked as
  785.         "dealt with" by the time the circle comes round to him again. A
  786.         similar thing would happen if a man had children by his ex-
  787.         wife's ex-husband's daughter. In practice this should rarely be
  788.         a problem and I have no intention of fixing it at present. You
  789.         will have to work round it by creating a dummy individual to
  790.         break the loop.
  791.  
  792.         To avoid having unnecessary repeated individuals, make sure that
  793.         the ancestor belonging to the earliest generation is given
  794.         first. Note that to force a sibship of a given parent to be
  795.         shown first it is only necessary to promote one of the sibs in
  796.         it to be first in the data file. However to force a sibship to
  797.         be last all the sibs must come after all the other children of
  798.         that parent.
  799.  
  800.         I don't know whether to recommend that the easiest way to get
  801.         the best-looking pedigree is to try to understand the algorithm
  802.         or just use trial and error. In my experience it is almost
  803.         always possible to get whole the pedigree displayed without any
  804.         repeats.
  805.  
  806.                                    13                                   
  807.  
  808.  
  809.  
  810.  
  811.                             PEDRAW.DOC v1.2                             
  812.  
  813.  
  814.  
  815.         * EXAMPLE SESSION
  816.  
  817.         To help explain the above I have enclosed an example data file
  818.         called EXPED.DAT. Use a text editor or word processor to read it
  819.         or print it out by entering:
  820.  
  821.         PRINT EXPED.DAT
  822.  
  823.         To produce pedigrees proceed as follows.
  824.  
  825.         First make sure that you are logged on to the disk containing
  826.         the above programs, and that you have changed directory (using
  827.         CHDIR) to the one that contains them. Then enter:
  828.  
  829.         PEDRAW
  830.  
  831.         Using the up-and-down arrows highlight the "Load pedigree file"
  832.         option and press Enter. Press Enter twice more to see a list of
  833.         all files in the subdirectory. Highlight EXPED.DAT and select it
  834.         by pressing Enter. The data file should be loaded in without
  835.         problems.
  836.  
  837.         Highlight the "Display pedigree" option and select it with
  838.         Enter. Press Enter again to see a list of ID's of everyone in
  839.         the pedigree. Highlight 12990 and select it with Enter. The
  840.         pedigree should be displayed (if not see the section on "Setting
  841.         the graphics display"). Press Esc and the diagram will be saved
  842.         to disk with the name 12990.MSP.
  843.  
  844.         Press Esc again to return to the main menu, then select "Quit"
  845.         to leave PEDRAW.
  846.  
  847.         If you have Microsoft Windows then you may wish to run that and
  848.         then select the file 12990.MSP to open with Paint. You can label
  849.         the pedigree with that and then print it out in the usual way.
  850.  
  851.         If you do not have Microsoft Windows, print out the pedigree by
  852.         entering:
  853.  
  854.         PRMSP 12990.MSP
  855.  
  856.         To see how PEDRAW uses .PED files, try selecting EXPED.PED
  857.         instead of EXPED.DAT and choose the ancestor 4001.
  858.  
  859.  
  860.         * MICROSOFT PAINT UTILITIES
  861.  
  862.         In addition to PRMSP, a number of utility programs for
  863.         manipulating Microsoft paint files are provided. These programs
  864.         are for resizing, joining and viewing files. They all work only
  865.         on "old format" paint files, so they will not work on files
  866.         saved from newer versions of Microsoft paint, or on .BMP files.
  867.  
  868.                                    14                                   
  869.  
  870.  
  871.  
  872.  
  873.                             PEDRAW.DOC v1.2                             
  874.  
  875.         However it should be possible to read the results in to Windows
  876.         paint without any difficulty (I think). Please note that these
  877.         programs may be quite slow on some computers.
  878.  
  879.         * Resizing paint files
  880.  
  881.         This can be done using the SIZEMSP.EXE program. Running this
  882.         program on its own gives you the current size of a paint file in
  883.         pixels:
  884.  
  885.         SIZEMSP filename.msp
  886.  
  887.         The size of the file is adjusted by entering four numbers to
  888.         increase the left, right, top, and bottom margins by that number
  889.         of pixels. The numbers for the left and right margins must be
  890.         divisible by eight. Negative numbers cut off that number of
  891.         pixels from the appropriate edge. E.g.:
  892.  
  893.         SIZEMSP filename.msp 16 16 4 -6
  894.  
  895.         Adds white space 16 pixels wide to the left and right edges,
  896.         adds 4 blank lines of pixels at the top, and snips off 6 lines
  897.         of pixels at the bottom.
  898.  
  899.         * Viewing paint files
  900.  
  901.         You can view files without having to print them out or load
  902.         Windows by entering:
  903.  
  904.         VIEWMSP filename.msp
  905.  
  906.         If the file is too big to be displayed on the screen you can
  907.         move around it using the cursor keys. Pressing the Escape key
  908.         quits the program.
  909.  
  910.         * Joining paint files
  911.  
  912.         Files can be combined into a larger paint file, either side by
  913.         side using SPLICMSP.EXE, or one under the other using
  914.         TAGMSP.EXE. The format for both programs is the same:
  915.  
  916.         TAGMSP file1.msp file2.msp [file3.msp ...] newfile.msp
  917.  
  918.         Several files can be joined at once in this way.
  919.  
  920.  
  921.         * HYPERTEXT HELP
  922.  
  923.         This documentation is available as a set of files which can be
  924.         read as pop-up hypertext help using MaxThink's HyperRez program.
  925.         If you have these files (generally distributed in the HELPINST
  926.         archive) then to read them first change into the directory in
  927.         which the files are located, then enter HR to load the program.
  928.         One can then change to another directory, and thereafter
  929.  
  930.                                    15                                   
  931.  
  932.  
  933.  
  934.  
  935.                             PEDRAW.DOC v1.2                             
  936.  
  937.         pressing the hot key combination (by default Control-B) at any
  938.         time will pop up the help. The hot key combination can be
  939.         changed using the HRK program supplied. Pressing F1 then
  940.         provides brief instructions on using the utility. With some
  941.         monitor types it would probably be unwise to attempt to pop up
  942.         the help when the monitor is in graphics mode, i.e. while a
  943.         pedigree diagram is actually being drawn or displayed. Otherwise
  944.         it can provide a useful reminder of how to use PEDRAW, although
  945.         having the program loaded (or any other pop-up program) does
  946.         take up a small amount of memory which therefore becomes
  947.         unavailable to PEDRAW.
  948.  
  949.  
  950.         * CLOSING COMMENTS
  951.  
  952.         All trademarks acknowledged. PEDRAW is freely distributed to
  953.         educational institutions, public health institutions and
  954.         individuals for their private use. All other users (including
  955.         private hospitals) must register the program before using it.
  956.         Contact me at the address below for details.
  957.  
  958.         I would be very glad to hear of comments/problems/suggestions
  959.         for improvements. One thing that is somewhat unsatisfactory but
  960.         that I probably will not be changing is the way that diagonal
  961.         lines which mark someone as deceased are rather short and get
  962.         truncated at the edges of the screen. I probably won't be
  963.         improving the facilities to print out pedigrees either, as
  964.         programs such as Windows do exist to do this and it is a rather
  965.         tedious way of reinventing the wheel. The text mode has now
  966.         fallen behind the graphics mode, but I have no real plans to
  967.         bring it back in line. Other features can be adjusted within
  968.         limits according to user demand, and if somebody has special
  969.         requirements then I may well be able to accommodate them.
  970.  
  971.         PEDRAW is written in C++ and makes fairly heavy use of routines
  972.         from the Zortech Flash Graphics library and C++ toolkit. I would
  973.         be willing to distribute to the source code to appropriate
  974.         individuals who wish to modify it (though it is not well
  975.         documented). Unfortunately I have made various modifications to
  976.         the toolkit and so I would have to pass that on as well, so
  977.         anybody wanting this code would have to furnish me with proof
  978.         that they had a copy of the toolkit already, e.g. by sending me
  979.         a listing of a header file or two.
  980.  
  981.         As far as upgrades are concerned, I will try to maintain a list
  982.         of people I know who are using PEDRAW and I may periodically
  983.         send out a notice announcing if I have made any significant
  984.         changes. If you did not obtain the program directly from me it
  985.         may be worth sending me your address so that I can add you to
  986.         this list. I aim to keep up-to-date versions at the following
  987.         sites from which they will be available by e-mail or anonymous
  988.         ftp:
  989.  
  990.  
  991.  
  992.                                    16                                   
  993.  
  994.  
  995.  
  996.  
  997.                             PEDRAW.DOC v1.2                             
  998.  
  999.         USA: SIMTEL collection
  1000.         Numerous mirror sites available by anonymous ftp and e-mail.
  1001.  
  1002.         Europe mailserver:
  1003.         mailserv@fi.uwasa.garbo
  1004.         Send mail with Subject: garbo-request
  1005.         and message: send help
  1006.  
  1007.         gene-server:
  1008.  
  1009.         Internet    gene-serverbchs.uh.edu
  1010.         BITNET/
  1011.         EARN        gene-server%bchs.uh.edu@CUNYVM
  1012.         UUCP        gene-server@bchs.UUCP (new style)
  1013.         Send mail with  Subject: SEND DOS HELP
  1014.  
  1015.         European:
  1016.         Anonymous FTP: nic.fun.com
  1017.         E-mail: mailserver@nic.funet.fi
  1018.         Send mail message: HELP
  1019.  
  1020.         European EMBL server:
  1021.         NETSERV@EMBL.BITNET
  1022.         Send mail message: DIR DOS_SOFTWARE
  1023.  
  1024.         USA anonymous FTP:
  1025.         manager: gilbertd@iubio.bio.indiana.edu
  1026.  
  1027.         UK only (JANET):
  1028.         call: uk.ac.lancs.pdsoft
  1029.         mailserver: archive-server@uk.ac.lancs.pdsoft
  1030.         Send message: send micros/ibmpc/INDEX
  1031.  
  1032.         Reference: CURTIS D. A program to draw pedigrees using LINKAGE
  1033.         or LINKSYS data files. Annals of Human Genetics 1990 54: 365-
  1034.         367.
  1035.  
  1036.         This work was supported in part by a post-doctoral training
  1037.         fellowship from the John D. and Catherine T. MacArthur
  1038.         Foundation Mental Health Research Network I (Psychobiology of
  1039.         Depression).
  1040.  
  1041.         Copyright Dave Curtis 1990
  1042.  
  1043.         Academic Department of Psychiatry
  1044.         University College and Middlesex School of Medicine
  1045.         Middlesex Hospital
  1046.         Mortimer Street
  1047.         London W1N 8AA, England                   Phone:  071 636 8333
  1048.                                                               x. 3049
  1049.         Janet:       dc@UK.AC.UCL.SM.PSYCH
  1050.         Elsewhere:   dc@PSYCH.SM.UCL.AC.UK
  1051.         EARN/Bitnet: dc%PSYCH.SM.UCL@UKACRL
  1052.         Usenet: ...!mcsun!ukc!mrccrc!D.Curtis
  1053.  
  1054.                                    17                                   
  1055.